Reference: fssProc |
fssProc generates the Sylia script command to configure the filter to its present configuration state.
Prototype |
bool fssProc(FilterActivation *fa, const FilterFunctions *ff, char *buf, int buflen); Parameters: fa Pointer to filter activation structure ff Pointer to callback function structure buf Buffer to deposit Config() string buflen Space available in buffer Return value: true if string should be included, false otherwise. Exceptions: No exceptions should be thrown from this function. Requirements: Function may be omitted. No default action is taken.
Remarks |
This function is the only method by which filters can store configuration parameters between the time a job entry is saved, and when that entry is executed. The string returned by fssProc is appended onto a configuration string of the form:
VirtualDub.video.filters.instance[0].
and thus the filter provides only the method call part of the string. Use _snprintf() or _vsnprintf() to generate the string, in case you might overflow the buffer. If you return false from the function, VirtualDub simply omits the script line entirely. Note that VirtualDub only has a 512 character buffer when executing script lines, so you can only count on 450 characters of space for your string even though there is usually 2K or so available to this function.
VirtualDub external filter SDK 1.05 | ©1999-2001 Avery Lee <phaeron@virtualdub.org> |